//
// "$Id: Fl_File_Browser.H 8864 2011-07-19 04:49:30Z greg.ercolano $"
//
// FileBrowser definitions.
//
// Copyright 1999-2010 by Michael Sweet.
//
// This library is free software. Distribution and use rights are outlined in
// the file "COPYING" which should have been included with this file.  If this
// file is missing or damaged, see the license at:
//
//     http://www.fltk.org/COPYING.php
//
// Please report all bugs and problems on the following page:
//
//     http://www.fltk.org/str.php
//

/* \file
   Fl_File_Browser widget . */

//
// Include necessary header files...
//

#ifndef _Fl_File_Browser_H_
#  define _Fl_File_Browser_H_

#  include "Fl_Browser.H"
#  include "Fl_File_Icon.H"
#  include "filename.H"


//
// Fl_File_Browser class...
//

/** The Fl_File_Browser widget displays a list of filenames, optionally with file-specific icons. */
class FL_EXPORT Fl_File_Browser : public Fl_Browser
{

	int		filetype_;
	const char	*directory_;
	uchar		iconsize_;
	const char	*pattern_;

	int		full_height() const;
	int		item_height(void *) const;
	int		item_width(void *) const;
	void		item_draw(void *, int, int, int, int) const;
	int		incr_height() const {
		return (item_height(0));
	}

public:
	enum { FILES, DIRECTORIES };

	/**
	  The constructor creates the Fl_File_Browser widget at the specified position and size.
	  The destructor destroys the widget and frees all memory that has been allocated.
	*/
	Fl_File_Browser(int, int, int, int, const char * = 0);

	/**    Sets or gets the size of the icons. The default size is 20 pixels.  */
	uchar		iconsize() const {
		return (iconsize_);
	};
	/**    Sets or gets the size of the icons. The default size is 20 pixels.  */
	void		iconsize(uchar s) {
		iconsize_ = s;
		redraw();
	};

	/**
	  Sets or gets the filename filter. The pattern matching uses
	  the fl_filename_match()
	  function in FLTK.
	*/
	void	filter(const char *pattern);
	/**
	  Sets or gets the filename filter. The pattern matching uses
	  the fl_filename_match()
	  function in FLTK.
	*/
	const char	*filter() const {
		return (pattern_);
	};

	/**
	  Loads the specified directory into the browser. If icons have been
	  loaded then the correct icon is associated with each file in the list.

	  <P>The sort argument specifies a sort function to be used with
	  fl_filename_list().
	*/
	int		load(const char *directory, Fl_File_Sort_F *sort = fl_numericsort);

	Fl_Fontsize  textsize() const {
		return Fl_Browser::textsize();
	};
	void		textsize(Fl_Fontsize s) {
		Fl_Browser::textsize(s);
		iconsize_ = (uchar)(3 * s / 2);
	};

	/**
	  Sets or gets the file browser type, FILES or
	  DIRECTORIES. When set to FILES, both
	  files and directories are shown. Otherwise only directories are
	  shown.
	*/
	int		filetype() const {
		return (filetype_);
	};
	/**
	  Sets or gets the file browser type, FILES or
	  DIRECTORIES. When set to FILES, both
	  files and directories are shown. Otherwise only directories are
	  shown.
	*/
	void		filetype(int t) {
		filetype_ = t;
	};
};

#endif // !_Fl_File_Browser_H_

//
// End of "$Id: Fl_File_Browser.H 8864 2011-07-19 04:49:30Z greg.ercolano $".
//
